PUT Existing Live Video

Overview

---

The table below provides key details about the PUT method for updating a Live Video.

PUT Existing Live Video
Method	PUT
URL or Endpoint	/api/v1/projectId/live-videos
Headers	Authorization
Parameters	projectId
Request Body	PublicId, Title, Description, PublishDate, PublishEndDate

The description of the URL parameter is as follows:

projectId URL Parameter
URL Parameter Name	projectId
Mandatory	Yes
Type	string
Description	Unique Id of the project.

Request Body

The description of the body parameters is as follows:

Parameter Name	Mandatory	Type	Description
PublicId	Yes	string	Public identifier of the live video
Title	Yes	string	Title of the live video
Description	No	string	Description of the live video
PublishDate	No	string($date-time)	The date and time when the video is scheduled to be published.
PublishEndDate	No	string($date-time)	The date and time when the publication of the video is set to end.

Response

{
    "success": true,
    "errors": [],
    "messages": [],
    "result": {
        "publicId": "{publicId}",
        "id": "{publicId}",
        "name": null,
        "title": "{title}",
        "description": "{description}",
        "playbackUrl": "",
        "thumbnail": "",
        "channelPublicId": "{channelId}",
        "channelName": null,
        "channelTitle": null,
        "liveStatus": null,
        "author": "{author}",
        "publishDate": "2024-05-23T10:00:00",
        "publishEndDate": null,
        "canCutAndPublish": false,
        "canStopAndCut": false
    },
    "resultInfo": null,
    "statusCode": 200
}

Information about the fields that appear when you receive the response are displayed in the table below.

Field Name	Type	Description
success	bool	If the response is successful, it will return true. Otherwise, it will return false.
errors	array[]	Indicates if there was an error.
messages	array[]	Returns the response message from the back-end.
result	array[Object]	Returns the response object.
publicId	string	Returns the public identifier of the live video.
id	string	Returns the identifier of the live video.
name	string	Returns a guid that is randomly generated.
title	string	Returns the title of the live video.
description	string	Returns the description of the live video.
playbackUrl	string	Returns a file URL where the livestream can be accessed for playback.
channelPublicId	string	Returns the public identifier of the channel.
channelName	string	Returns the name of the channel.
channelTitle	string	Returns the title of the channel.
liveStatus	string	Indicates the live status of the live video.
author	string	Returns the author of the live video.
publishDate	string($date-time)	Returns the date and time when the video was created.
publishEndDate	string($date-time) or null	Returns the date and time when the publication of the video is set to end.
hasCustomDate	boolean	Returns whether a custom start and end date has been set for the video.
startDateUTC	string($date-time)	Returns the date and time in UTC when the video is scheduled to start being available.
endDateUTC	string($date-time) or null	Returns the date and time in UTC when the video is scheduled to end.
countdownEnabled	boolean	Returns whether a countdown timer is enabled for the video.
countdownSeconds	integer($int32)	Returns the duration of the countdown timer in seconds.
canCutAndPublish	boolean	Returns a value indicating if the video can be cut and published.
canStopAndCut	boolean	Returns a value indicating if the video can be stopped and cut.
resultInfo	string	Returns extra information about the result. (May be null)
statusCode	integer($int32)	Returns the HTTP Status Code.

If the action is successful, the service sends back an HTTP 200 or 201 response.

Errors

For information about the errors that are common to all actions, see Common Errors:

• HTTP Status Code 400: Bad Request

• HTTP Status Code 401: Unauthorized

• HTTP Status Code 403: Forbidden

• HTTP Status Code 404: Result Not Found

• HTTP Status Code 500: Internal Server Error

• HTTP Status Code 503: Backend Fetch Failed